home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 2.iso / STUTTGART / GRAPHICS / TOOLS / SPRVIEW / !SprView / !Help < prev    next >
Text File  |  1993-08-17  |  10KB  |  256 lines
  1. // ----------------------------------------------------------------------------
  2. // !SPRITEVIEW (VERSION 0.21) !HELP FILE
  3. // ----------------------------------------------------------------------------
  4. // Note: Additions since version 0.16 can be seen easily in the history file
  5.  
  6.  
  7. !SpriteView is a simple sprite viewer. I know there are a lot of them about
  8. but hopefully this has a few different features.
  9.  
  10. I wrote !SpriteView because I wasn't happy with the facilities given by most
  11. sprite viewers and backdrop utilities. I wanted to be able to have
  12. 'frontdrops' as well as 'backdrops' and to be able to view sprites without a
  13. title bar, scroll areas, etc. This application provides that and a little
  14. more but still remains *simple* (don't be fooled by the size of this !help
  15. file).
  16.  
  17. Using !SpriteView, you can easily create collages of sprites by placing
  18. sprites side by side and 'grabbing' the result.
  19.  
  20. Using !SpriteView, you can grab the (visible) contents of a tasks window
  21. (including the iconbar or the backdrop) as a sprite or grab an area of the
  22. screen.
  23.  
  24. // ----------------------------------------------------------------------------
  25. // MAIN FEATURES
  26.  
  27. Even though sprites appear inside !SpriteView with no title bar, scroll bars
  28. or icons, the sprite can be:
  29.  
  30.  • moved around the screen
  31.  
  32.     Simply drag the sprite. Select brings the window to the
  33.     front while Adjust leaves it where it is in relation to the
  34.     other windows
  35.     
  36.  • put to the back
  37.  
  38.     DoubleClick on the sprite. To bring it to the front, press
  39.     Select or Adjust over the sprite for a short period.
  40.     
  41.  • resized
  42.  
  43.     Alt-drag the sprite (that is, start the drag with either Alt
  44.     key down). You can move any side of the frame by starting
  45.     the drag with Select closest to the side you want. Any
  46.     corner can be moved by using Adjust to start the drag in the
  47.     corner of your choice.
  48.     
  49.   • shifted inside its transparent frame
  50.  
  51.     Shift-drag the sprite. Some of the sprite must be hidden
  52.     from view inside the frame for this to work. If you drag
  53.     with Select, the sprite may be shifted only horizontally or
  54.     vertically, depending on the initial direction of the drag.
  55.     If you drag with Adjust, the sprite may be shifted in any
  56.     direction.
  57.     
  58.  • kept static while its frame is moved
  59.  
  60.     To get the effect that the frame really is a window onto the
  61.     sprite, Ctrl-drag allows you to move the frame while the
  62.     sprite remains in the same position on the screen. As with
  63.     other drags, use Adjust to allow bi-directional scrolling.
  64.         
  65.  • locked into position
  66.  
  67.     Choose "Lock" from that sprite's menu. The sprite will now
  68.     resist all (documented!) attempts to move it though it will
  69.     not resist being moved about in the stack (and double-click
  70.     will still work).
  71.     
  72.     To unlock the sprite, choose "Unlock".
  73.     
  74.  • stuck in front or at the back
  75.  
  76.     Choose "Stick->To top" or "Stick->To bottom" from the
  77.     sprite's menu. The sprite will now keep itself at the back
  78.     of all the windows or in front of them. You can still move
  79.     the sprite around or shift it inside its frame.
  80.         
  81.     To temporarily stop the sprite from adjusting it's position
  82.     on the window stack hold down a key (I suggest Shift, Ctrl
  83.     or Alt). You will find this handy to get at the sprite's
  84.     menu when you have selected "Stick->To top".
  85.     
  86.     The sprite may appear temporarily behind or infront of
  87.     another window when it shouldn't but will correct itself
  88.     soon enough. 
  89.     
  90.     To unstick a sprite, choose "Stick->Unstick" (which appears
  91.     when the sprite is stuck).
  92.         
  93. You can also:
  94.  
  95.  • grab sprites
  96.  
  97.     From the iconbar menu, choose 'Grab->Area' to select an
  98.     area of the screen as a sprite or choose 'Grab->Contents'
  99.     to select a task's window *contents* as a sprite.
  100.     
  101.     Once a menu entry has been chosen, the pointer will change
  102.     shape. At any time, you can press Menu to abort the grab.
  103.     Click Select to mark one corner of the area or to choose
  104.     which window you require to be grabbed.
  105.     
  106.     For a screen area grab you now move the mouse to the
  107.     opposite corner of the desired area and click Select, or
  108.     click Adjust to move the initial corner to the current
  109.     position (click Menu to abort the grab).
  110.     
  111.     Note that the area currently selected for grabbing will be
  112.     inverted until the final mouse click.
  113.     
  114.  • have a number of copies of the same sprite on the screen
  115.  
  116.     To do this, select "New view" from that sprite's menu. All
  117.     sprites will be completely independent of one another but
  118.     taking up no extra space.
  119.    
  120.     See also 'Key Shortcuts' below.
  121.  
  122.  • select individual sprites from a large sprite file
  123.  
  124.     Ctrl-doubleclicking on the sprite file or ctrl-dragging it
  125.     to !SpriteView's icon will prompt !SpriteView to open a file
  126.     information window. This window is explained in detail below
  127.     in the section 'File Information Windows'.
  128.        
  129.  • remove sprites from !SpriteView
  130.  
  131.     To remove a sprite, press Menu on the sprite and choose
  132.     "Remove". If you go to the Remove submenu, you can choose
  133.     to remove the sprite you were pointing at, all copies of this
  134.     sprite or all sprites in !SpriteView.
  135.    
  136.     See also 'Key Shortcuts' below.
  137.  
  138. // ----------------------------------------------------------------------------
  139. // KEY SHORTCUTS
  140.  
  141. If the mouse is clicked on a sprite window, it gains the input focus and accepts
  142. the following key strokes:
  143.  
  144.     ^B - Put to back.
  145.     ^C - Crop.
  146.     ^F - Bring to front.
  147.     ^O - Open the sprite window fully.
  148.     ^N - New View.
  149.     ^R - Remove Sprite.
  150.     
  151.     The arrow keys flip the sprite.
  152.  
  153. // ----------------------------------------------------------------------------
  154. // FILE INFORMATION WINDOWS
  155.  
  156. File information windows allow you to select individual sprites from large
  157. sprite files without loading any sprites until you select one/some to view.
  158. These windows can be obtained by ctrl-dragging a sprite file onto
  159. !SpriteView's icon or ctrl-doubleclicking on the sprite file.
  160.  
  161. When the window opens, you will be able to see the size of the file and the
  162. number  of sprite definitions it contains along with a long list of sprite
  163. names. If you click Select on a button next to a sprite name, that sprite
  164. will be loaded. !SpriteView will beep if that sprite's window is already
  165. being displayed.
  166.  
  167. To remove a sprite from display, click Adjust on the button next to the name.
  168. !SpriteView will beep if the window opened is no longer on display.
  169.  
  170. // ----------------------------------------------------------------------------
  171. // A NOTE ON MEMORY USAGE
  172.  
  173. !SpriteView uses a heap but as yet not a shifting heap. Memory is released from
  174. its WimpSlot when a page (or more) is freed at the end of this space.
  175.  
  176. If you need reduce the amount of memory !SpriteView is using you can:
  177.   • Remove all sprites and close all sprite file information windows.
  178.   
  179.      This is the second most obvious option.
  180.     
  181.   • Save sprites from !SpriteView into itself and delete the originals.
  182.   
  183.      This is handy if you have cropped a sprite and removed the original
  184.      since the original sprite will have left a chunk of free space which
  185.      might reside lower in the free space than the new cropped section.
  186.      
  187.      Also, grabbed sprites are likely to take up more memory when first
  188.      grabbed than they really need so saving, removing and resaving them
  189.      might save you some space if you're desperate.
  190.      
  191.   • Quit !SpriteView
  192.   
  193.      The most obvious option!
  194.                 
  195. // ----------------------------------------------------------------------------
  196. // HOW TO START SPRITE VIEW
  197.  
  198. To load the application, double-click on the !SpriteView icon.
  199.  
  200. To load a sprite into the application, drag a Sprite file from the desktop
  201. onto the icon on the icon bar.
  202.  
  203. General manipulation of loaded sprites is detailed above.
  204.  
  205. To quit the application choose "Quit" from the iconbar menu or from the task
  206. display entry "Sprite View".
  207.  
  208. // ----------------------------------------------------------------------------
  209. // COMMENTS AND SUGGESTIONS WELCOME!!!!
  210.  
  211. If you have any comments or suggestions then please let me know. I'm
  212. currently on holiday from University without direct access to the network
  213. but will be available by acoustic mail.
  214.  
  215. My term-time email address is:
  216.  
  217.     m91jjs@ecs.oxford.ac.uk
  218.  
  219. My home address is:
  220.  
  221.     Mr Joss Smith
  222.     34 Ivythorn Road
  223.     Street
  224.     Somerset BA16 0TF
  225.     ENGLAND
  226.  
  227. Please note: This release has been based on the information in the RO2 PRM's.
  228. I haven't got the RO3 ones yet (and won't less I get some cash!)
  229.  
  230. Thanks got to Ian Fry (for looking over version 0.15) and Mike Borcherds for
  231. getting !SprView onto an archive.
  232.  
  233. I'd also like to congratulate Thomas Aeby for giving me a life line - a
  234. FREEWARE C/C++ compiler (since the first release of this application I've
  235. started using release B of GCC).
  236.  
  237. // ----------------------------------------------------------------------------
  238. // LEGAL(ISH) SPIEL
  239.  
  240. This application is freeware. I retain copyright but allow free
  241. distrubution of this Software provided all documentation is kept in its
  242. original state and distributed as part of the Software.
  243.  
  244. This Software is not to be sold for profit and any party interested in
  245. distributing it for profit must receive written permission from the author.
  246.  
  247. // ----------------------------------------------------------------------------
  248. // OH AND...
  249.  
  250. If you should feel like sending me donations (£5.00 upwards) I'll 
  251. consider sending you the latest version (or the next one that I feel
  252. is fairly stable and has some new features) though I might just
  253. fall asleep.
  254.  
  255. // ----------------------------------------------------------------------------
  256.